[Doc] Clarify the session-specific nature of RID and ObjectID
#93190
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AThousandShips
added
enhancement
documentation
cherrypick:4.1
AThousandShips
commented
Jun 15, 2024
doc/classes/Object.xml
Outdated
| @@ -693,6 +693,7 @@ | |||
| <return type="int" /> | |||
| <description> | |||
| Returns the object's unique instance ID. This ID can be saved in [EncodedObjectAsID], and can be used to retrieve this object instance with [method @GlobalScope.instance_from_id]. | |||
| [b]Warning:[/b] This ID is specific to the running session. This means that it won't match the same object if sent over a network, or loaded from a file at a later time. | |||
There was a problem hiding this comment.
We could go with "isn't guaranteed to match" as it's technically possible to match up, but I think it's best to be negative here and just say they won't (they won't in general, a lot of things would have to match for them to match up in any non-toy setup) to avoid anyone just trusting to luck
Mickeon
reviewed
Jun 17, 2024
AThousandShips
force-pushed
the
session_doc
branch
from
9fc4bae
to
6ab303c
Compare
akien-mga
approved these changes
Jun 18, 2024
|
Thanks! |
|
Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Unsure if it should be a
Noteor aWarning, and if it should suggest other means to do things instead of using these types, but this helps clarifying the nature (and why they can't generally be serialized in the case ofRID)